Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update unclog instructions #1481

Merged
merged 2 commits into from
Dec 6, 2023
Merged

docs: update unclog instructions #1481

merged 2 commits into from
Dec 6, 2023

Conversation

mpoke
Copy link
Contributor

@mpoke mpoke commented Dec 5, 2023

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

@mpoke mpoke requested a review from a team as a code owner December 5, 2023 13:14
Copy link
Contributor

@p-offtermatt p-offtermatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a comment

- add the date as the summary of the release (`unclog release` requires adding a summary), e.g.,
```md
*December 5, 2023*
```
Copy link
Contributor

@p-offtermatt p-offtermatt Dec 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth adding, to avoid any confusion, that this is the only thing that should be added here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not always the only thing, but in general, this should be enough.

@mpoke mpoke added this pull request to the merge queue Dec 6, 2023
Merged via the queue into main with commit a9b090f Dec 6, 2023
13 checks passed
@mpoke mpoke deleted the marius/release-process branch December 6, 2023 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants